/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.persistence.criteria.enumeration;

/**
 * this enum represents a strategy for matching strings using LIKE operator.
 */
public enum MatchMode
{

  /**
   * exactly the given value.
   */
  EXACT(true, true),
  /**
   * the given value is at the beginning of the word.
   */
  START(true, false),
  /**
   * the given value can be anywhere inside the word.
   */
  ANYWHERE(false, false),
  /**
   * the given value is at the ending of the word.
   */
  END(false, true);

  /**
   * the result must start with the given value.
   */
  private boolean startsWith;

  /**
   * the result must end with the given value.
   */
  private boolean endsWith;



  /**
   * the private constructor of the enum.
   * 
   * @param startsWith
   *          the result must start with the given value.
   * @param endsWith
   *          the result must end with the given value.
   */
  private MatchMode(final boolean startsWith, final boolean endsWith)
  {
    this.startsWith = startsWith;
    this.endsWith = endsWith;
  }



  /**
   * return if the result must start with the given value.
   * 
   * @return if the result must start with the given value.
   */
  public boolean startsWith()
  {
    return startsWith;
  }



  /**
   * return if the result must end with the given value.
   * 
   * @return if the result must end with the given value.
   */
  public boolean endsWith()
  {
    return endsWith;
  }

}
